home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / wb / WBTitle13d.lha / WBTitle13d.doc < prev   
Encoding:
Text File  |  1995-04-12  |  5.4 KB  |  163 lines
  1. WBTitle Documentation
  2. * Update: v1.3d - bugfixed and enhanced version for German WB locale
  3. * by Martin Kaim (Gwardar) 11-04-95
  4. * Note: Any parts of this doc file marked * were added or adapted by Gwardar
  5.  
  6. Designed and Implemented by Mark Thomas
  7. This software is placed in the public domain.
  8. You may modify the program or use the code in anyway you see fit.
  9. I make no claims as to the code's fitness for use in any setting.
  10. I make no claims as to the program's fitness for use in any setting.
  11. Use the code or program at your own risk.
  12.  
  13. * Enhancements, bugfixes, German Workbench locale adjustments
  14. * by Gwardar.
  15.  
  16. * The entire risk of using this software is with the user. The authors
  17. * cannot be held responsible for any possible damages arising from the
  18. * use of this software.
  19.  
  20. Motivation
  21.  
  22. I was reading someone's message on Usenet when something he said made
  23. me come up with the idea for this program.  The actual technical
  24. notion came from comments in the docs for the VMM virtual memory
  25. program by Martin Apel.  Thanks for the clue on patching Intuition.
  26.  
  27. I also was concerned that there might not be any good source code
  28. example on how to do SetFunction() from C.  The source code for this
  29. program is in the archive.
  30.  
  31.  
  32. Overview
  33.  
  34. WBTitle is a program that lets you replace your Workbench title bar
  35. with just about any text you like.  It also gives you the facilities
  36. to put memory readings in the title bar.  At its simplest, you could
  37. replace the title bar with the same text that is already there, and
  38. in the exact same format.  But WBTitle allows you to do more.
  39.  
  40.  
  41. Features
  42.  
  43. The title bar replacement is partitioned into three main parts,
  44. prefix, memory, and postfix.  They are combined in the order
  45. prefix-memory-postfix to make the title bar text.
  46.  
  47. The prefix is just a string of text that appears at the leftmost part
  48. of the title bar.  The memory consists of memory strings.  There can
  49. be several items in the memory section, shown shortly.  The postfix
  50. is simply some text that appears at the end of the title bar text.
  51.  
  52. As stated above, the memory can have several parts.  Each part is a
  53. memory reading (amount of free memory with a label).  The memory
  54. displays that are available are chip, fast, public, total, virtual,
  55. and retina.  Chip, fast, public, and total are normal Amiga memory
  56. options.  Virtual is for use with the VMM program for showing free
  57. virtual memory.  Retina is for use with a Retina graphics card for
  58. showing the amount of free graphics memory.
  59.  
  60. The memory reading consists of the memory value and a label (some
  61. text).  All labels come either before the memory value or after the
  62. memory value, which is determined by the LABELS option described
  63. below.
  64.  
  65.  
  66. Requirements
  67.  
  68. For the VMM virtual memory option to work, the library that comes
  69. with VMM, "vmm.library", will have to be placed in LIBS:.
  70.  
  71. * For the Retina gfx board memory option to work, you need a properly
  72. * set up Retina software package and hardware.
  73.  
  74. Options
  75.  
  76. All the options are specified in the tool types to keep the program
  77. size small.  Tool types are entered from the Workbench by clicking
  78. on the WBTitle icon and choosing Information... from the Icons menu.
  79. Here are the tool types:
  80.  
  81. PREFIX
  82.  
  83. Lets you set the prefix text.
  84. Default: "PREFIX=Amiga Workbench "
  85.  
  86. SUFFIX
  87.  
  88. Lets you set the suffix text.
  89. Default: "SUFFIX="
  90.  
  91. LABELS
  92.  
  93. Lets you specify if the memory labels are placed before or after
  94. the memory values so that you can do things like "Chip: 1,232,848"
  95. or "1,012 KB Chip Mem".
  96.  
  97. MEMORDER
  98.  
  99. Allows you to set the order of the memory readings, as well as which
  100. memory values are to be used.  It consists of a several letters that
  101. you arrange in the order you want the readings.  Each letter stands
  102. for a particular memory type:  C for chip, F for fast, P for public,
  103. T for total, V for virtual, and R for Retina.
  104. Default: "MEMORDER=CVPR"
  105.  
  106. CHIP
  107.  
  108. Lets you set the text that appears with the chip memory reading.
  109. Default: "CHIP= Chip"
  110.  
  111. FAST
  112.  
  113. Lets you set the text that appears with the fast memory reading.
  114. Default: "FAST= Fast"
  115.  
  116. PUBLIC
  117.  
  118. Lets you set the text that appears with the public memory reading.
  119. Default: "PUBLIC= Public"
  120.  
  121. TOTAL
  122.  
  123. Lets you set the text that appears with the total memory reading.
  124. Default: "TOTAL= Total"
  125.  
  126. VIRTUAL
  127.  
  128. Lets you set the text that appears with the virtual memory reading.
  129. Default: "VIRTUAL= Virtual"
  130. * Text will only appear if VMM is installed and ACTIVE!
  131.  
  132. RETINA
  133.  
  134. Lets you set the text that appears with the retina memory reading.
  135. Default: "RETINA= Retina"
  136. * Text will only appear if Retina is installed correctly!
  137.  
  138. THOUSANDSEP
  139.  
  140. Lets you choose whether memory values have a separator before each
  141. thousands group or not.  If this is set, your memory values would
  142. * have the format "1.228.352".  If this is not specified, your memory
  143. values would have the format "1228352".
  144. Default: there is no default
  145.  
  146. SEPARATOR
  147.  
  148. Allows you to set the character used to separate the thousands groups
  149. in memory values.  This is to allow for other countries.
  150. * Default: "SEPARATOR=." (German locale)
  151.  
  152. UNITS
  153.  
  154. Allows you to set the accuracy of the memory values.  It's easiest
  155. to show an example.  If you have a memory value 1,228,352 and this
  156. is set to 1, then that's exactly what you see, 1,228,352.  If you
  157. wanted to see only how many kilobytes you have free, you can set the
  158. value to 1024 and you would see 1,199, since that's the number of
  159. kilobytes in 1,228,352.  So whatever value is the real memory
  160. setting, it gets divided by this value.  Setting to 0 will end up as
  161. a setting of 1 so that divides by zero are avoided.
  162. Default: "UNITS=1"
  163.